chore: make demo readme more clear for new developers #974
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rthomare
requested review from
moldy530,
dancoombs,
mokok123 and
dphilipson
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
rthomare
force-pushed
the
rohan/chore/updateDemoReadme
branch
from
572cc22
to
c446413
Compare
RobChangCA
previously approved these changes
Sep 20, 2024
moldy530
reviewed
Sep 23, 2024
examples/ui-demo/README.md
Outdated
Comment on lines
14
to
20
| npm install | ||
| # or | ||
| yarn install | ||
| # or | ||
| pnpm install | ||
| # or | ||
| bun install |
There was a problem hiding this comment.
we use yarn everywhere so we should just have this be that
examples/ui-demo/README.md
Outdated
Comment on lines
27
to
33
| npm build | ||
| # or | ||
| yarn build | ||
| # or | ||
| pnpm build | ||
| # or | ||
| bun build |
dphilipson
previously approved these changes
Sep 26, 2024
examples/ui-demo/README.md
Outdated
|
|
||
| First, run the development server: | ||
| ## Setup your Enviornment |
There was a problem hiding this comment.
Nit: typo "enviornment" -> "environment", Also "your" should be capitalized in titles, it's only articles and prepositions that aren't. Also, "Setup" -> "Set Up": "setup" is a noun but "set up" is a verb.
examples/ui-demo/README.md
Outdated
|
|
||
| First, run the development server: | ||
| ## Setup your Enviornment | ||
| 1. Ensure you have the right npm version corresponding to the `/aa-sdk/.nvmrc` file. |
There was a problem hiding this comment.
That's actually the node version, not the npm version.
examples/ui-demo/README.md
Outdated
| ## Setup your Enviornment | ||
| 1. Ensure you have the right npm version corresponding to the `/aa-sdk/.nvmrc` file. | ||
| 2. Go to Alchemy's Dashboard, and setup an [account config](https://dashboard.alchemy.com/accounts/config/create). | ||
| 1. For local developement set the configuration with a redirect url to http://localhost:3000. |
There was a problem hiding this comment.
Typo: "developement" -> "development"
examples/ui-demo/README.md
Outdated
| First, run the development server: | ||
| ## Setup your Enviornment | ||
| 1. Ensure you have the right npm version corresponding to the `/aa-sdk/.nvmrc` file. | ||
| 2. Go to Alchemy's Dashboard, and setup an [account config](https://dashboard.alchemy.com/accounts/config/create). |
There was a problem hiding this comment.
(Very nit) As above, "setup" -> "set up".
rthomare
force-pushed
the
rohan/chore/updateDemoReadme
branch
from
c446413
to
fdb1368
Compare
dphilipson
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR updates the
README.mdin theexamples/ui-demodirectory to improve clarity and organization regarding setup instructions.Detailed summary
## Getting Startedto# Getting Started.## Setup your Environmentwith detailed steps for environment configuration.## Install Dependencieswith installation instructions.## Build the aa-sdk Librarieswith build instructions.## Start the Serverwith instructions to start the server.